Developer --> Technical Publications
PATHHardware Documentation > USB Devices > Mac OS USB DDK API Reference


USBSetPipeActiveByReference

The USBSetPipeActiveByReference function sets the state of a specified pipe to active.

OSStatus USBSetPipeActiveByReference(USBPipeRef ref);

--> ref
Pipe reference.

The pipe status is set to active if the pipe is not stalled. The idle state is cleared, stalled is not.

Errors returned by the USBSetPipeActiveByReference function include:

kUSBUnknownPipeErr
-6997 pipe reference specified is unknown
kUSBPipeIdleStalled
-6979 pipe was stalled, pipe is set idle

In version 1.0 of the USB Services software, the following error is returned if the pipe was previously idle. In this instance the call has succeeded despite the returned error. This behavior is not an error and noErr is returned in versions 1.0.1 and later of the USB Services software.

kUSBPipeIdleErr
-6980 pipe was previously idle, pipe is still made active

© 1999 Apple Computer, Inc.

Previous | Back Up One Level | Next | Show Frames | Hide Frames